qaCtlReleaseClientId.h

Go to the documentation of this file.

/*
 * \ingroup ctl
 *
 * \file qaCtlReleaseClientId.h
 *
 * \brief This file contains definitions, enumerations, structures and
 *        forward declarations for qaCtlReleaseClientId.c
 *
 * Copyright: © 2019 Sierra Wireless, Inc. all rights reserved
 *
 */

#ifndef __CTL_RELEASE_CLIENT_ID_MSG_H__
#define __CTL_RELEASE_CLIENT_ID_MSG_H__



/* enum declarations */
/*
 * An enumeration of eQMI_CTL_RELEASE_CLIENT_ID request TLV IDs
 *
 */
enum eCTL_RELEASE_CLIENT_ID_REQ
{
    eTLV_CLIENT_ID_TO_RELEASE = 0x01
};

enum CTL_RELEASE_CLIENT_ID_RESP
{
    eTLV_RELEASED_CLIENT_ID = 0x01
};

/*
 * This structure contains the ReleaseClientId request parameters.
 *
 * \sa qaGobiApiCtl.h for parameter descriptions
 *
 */
struct QmiCtlReleaseClientIdReq
{
    BYTE serviceType;
    BYTE clientId;
};

/*
 * This structure contains the ReleaseClientId response parameters.
 *
 */
struct QmiCtlReleaseClientIdResp
{
    /* Every response message must have a results structure */
    struct qmTlvResult results;

    BYTE* pServiceType;
    BYTE* pClientId;
};

/*
 * Prototypes
 *
 */
extern enum eQCWWANError PkQmiCtlReleaseClientId(
    WORD  *pMlength,
    BYTE  *pBuffer,
    BYTE serviceType,
    BYTE clientId );

extern enum eQCWWANError UpkQmiCtlReleaseClientId(
    BYTE *pMdmResp,
    struct QmiCtlReleaseClientIdResp *pApiResp );

#endif /* __CTL_RELEASE_CLIENT_ID_MSG_H__ */